System APIs
Stores information about a domain value
| HTTP method | PUT |
| URI | https://api.rambase.net/system/domain-values/{domainValueId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {domainValueId} |
Identifier of the domain value
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 350, version 8 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
DomainValue
This field is optional.
>Object
Object/archive/context of the DOV
This field is optional.
>{String}</Object>Field
Fieldname of the DOV
This field is optional.
>{String}</Field>Value
Value of the DOV
This field is optional.
>{String}</Value>Priority
Priority of the domainvalue
Minimum value: 0
This field is optional.
>{Integer}</Priority>Description
Description of the name/value/code/key
This field is optional.
>{String}</Description>Repository
This field is optional.
>Scope
Scope of the DOV (LOCAL/GLOBAL)
This field is optional.
>{String}</Scope>LocalMode
Defines rules for local editing
This field is optional.
>{String}</LocalMode>DomainValue
This field is optional.
": {Object
Object/archive/context of the DOV
This field is optional.
": "{String}",Field
Fieldname of the DOV
This field is optional.
": "{String}",Value
Value of the DOV
This field is optional.
": "{String}",Priority
Priority of the domainvalue
Minimum value: 0
This field is optional.
": "{Integer}",Description
Description of the name/value/code/key
This field is optional.
": "{String}",Repository
This field is optional.
": {Scope
Scope of the DOV (LOCAL/GLOBAL)
This field is optional.
": "{String}",LocalMode
Defines rules for local editing
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 100065 HTTP 400 | Can not change Scope from Global to Local |
| Error 100060 HTTP 400 | The combination of OBJECT, FIELD and VALUE already exists |